HLS Salesforce CDP System API - Implementation Template

(0 reviews)

Setup guide

Importing Templates into Anypoint Studio

  1. In Studio, click the Exchange X icon in the upper left of the taskbar.
  2. Log in with your Anypoint Platform credentials.
  3. Search for the template.
  4. Click Open.

Running Templates in Anypoint Studio

After you import your template into Studio, follow these configuration steps to run it:

Common Configuration

  • mule.env - sets the environment where the application is to be deployed. It should be configured in config-<mule.env>.yaml file. For a studio deployment, the recommended mule.env value is local.
  • mule.key - sets the encryption password to be used for encrypting secure properties. Update as needed.
  • api.autoDiscoveryID should be configured in config-<mule.env>.yaml file.

HTTPS Configuration

  • https.host — sets the service host interface. It should be configured in config-<mule.env>.yaml file. (Defaults to 0.0.0.0 for all interfaces)
  • https.port — sets the service port number. It should be configured in config-<mule.env>.yaml file. (Default 8082)
  • TLS Configuration - Keystore properties are setup in Common core library used in the project. Reference can be found by downloading the Accelerator Setup Guide asset. For customization, refer instructions available in Accelerator Setup Guide - Additional customization section.

Please refer to the attached link on how to generate the Keystore.

Salesforce CDP Configuration

The Salesforce CDP connector supports OAuth JWT and OAuth Username Password authentication. Below configuration is required for using OAUTH JWT.

  • cdp.consumerKey - sets the Consumer key for the Salesforce-connected app. Refer to below Salesforce CDP connector link and navigate to the Salesforce documentation for information about generating a consumer key. It should be encrypted and configured in config-secured-<mule.env>.yaml file.
  • cdp.keystore.path - sets the Path to the keystore that signs data during authentication. It should be configured in config-<mule.env>.yaml file.
  • cdp.keystore.password — sets the Password for the keystore. It should be encrypted and configured in config-secured-<mule.env>.yaml file.
  • cdp.keystore.alias - sets the Alias of the certificate to use. It should be configured in config-<mule.env>.yaml file.
  • cdp.username - sets the username of the Salesforce user. It should be configured in config-<mule.env>.yaml file.
  • cdp.audienceUrl - sets the URL of the authorization server. It should be configured in config-<mule.env>.yaml file.

Please refer to this link for configuring the Salesforce CDP connector and this link on how to secure the configuration properties.

Run it

  1. Right-click the template project folder.
  2. Hover your mouse over 'Run as'.
  3. Click Mule Application (configure).
  4. Inside the dialog, select Environment and set the variable mule.env to the appropriate value (e.g., dev or local).
  5. Inside the dialog, select Environment and set the variable mule.key.
  6. Inside the dialog, go to 'Clear Application Data' select 'always' radio button.
  7. Click Run.

Deployment instructions for CloudHub using provided scripts

Ensure the Maven profile CloudHub-DEV has been properly configured in your settings.xml file. Reference can be found by downloading the Accelerator Setup Guide asset. Additional instructions are available in Accelerator Setup Guide - Configuring the Accelerator Build section.

Update the config-<env>.yaml properties appropriately and then use one of the following scripts to deploy the application to CloudHub:

  • packageDeploy.sh or deployOnly.sh (Mac/Linux).
  • packageDeploy.cmd or deployOnly.cmd (Windows).

Test it

  • Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.

Reviews

TypeTemplate
OrganizationMulesoft
Published by
MuleSoft Organization
Published onDec 17, 2022
Asset overview

Asset versions for 1.0.x

Asset versions
VersionActions
1.0.0